becu-interop-platform-api

1.0.x
(0 reviews)

Get Assets

Description

This page consists of the information regarding the operation performed to retreive assets/APIs available on Anypoint Exchange.

This API can be leveraged to get the list of APIs exposed in Anypoint Exchange

Endpoints

  • /assets
  • /assets/checkStatus/{applicationName}

API Design Endpoint Sequence Diagram

BECU Interop Platform API orchestrates API calls to the internal-Anypoint Platform and Anypoint exchange APIs to retreive list of APIs exposed in Exchange. The below diagram depicts the various platform APIs invoked for this process.

resources/image-7eb61bb3-4b28-46f4-8622-1a89978e5df2.png

Get Asset Deployment Metadata

Using /assets/checkStatus/{applicationName} endpoint, we can retrieve the deployment metadata of a specific asset, including its deployment status.

The following fields are retrieved:

  • applicationName: The name of the asset
  • status: The current status of the asset, all possible status values are:
    • UNDEPLOYED - Application is not active in any server
    • DEPLOYING - Some servers are in the process of deploying, but none are running
    • STARTED - App deployment is successfully completed on at least one server
    • UNDEPLOYING - App is in the process of shutting down
    • DEPLOY_FAILED - No deploying or running servers
    • DELETED - The application is marked like deleted
  • lastUpdateTime: Tha last time the asset was updated
  • deployedFileName: The filename of the deployed asset
  • * deploymentUpdateStatus: The status of an asset deployment, this key will only be present if the asset is currently being deployed
Get Asset Deployment Metadata using CloudHub Connector or API

When fetching the deployment status of an asset the user is given two approaches: using CloudHub Connector or CloudHub API. The user is given this choice to future-proof this method, so data can be fetched successfully even if a migration to CloudHub 2.0 occurs or CloudHub Connector gets deprecated.

The chConnector flag can be passed as a header to indicate the usage of CloudHub API.

  • Pass this flag with a value of true to fetch the metadata using CloudHub Connector
  • Pass this flag with a value of false to fetch the metadata using CloudHub API
  • If no flag/header is passed the data gets fetched using CloudHub Connecor by default

Connectors & Common API Dependency

The BECU Interop Platform API, is consuming multiple connectors and Anypoint Platform REST APIs.

Below are the list of connectors which this API is consuming:

  • HTTP Connector
  • Transform Message
  • JSON Logger

Downstream Dependencies

Anypoint Platform REST APIs

Anypoint Platform Login API

Anypoint Exchange API for

  - Get Assets

Reviews